Description
Used to define a custom toolbutton or specify a built-in toolbutton in a pull-down menu.
Diagram
Overview
![](xsdimages/element.png) |
MENUITEM 1..∞
Used to define a custom toolbutton or specify a built-in toolbutton in a pull-down menu.
![](xsdimages/attributeref.png) |
caption optional xs:string
Displayed in the toolbar.
|
![](xsdimages/attributeref.png) |
command optional xs:string
When parent is ToolButton:
Built-in tool name (for example, addlayer).
|
![](xsdimages/attributeref.png) |
image optional xs:string
Path to a 16X16 .bmp image file, .ico file or the name of a built-in image (for example, $bex).
|
![](xsdimages/attributeref.png) |
name optional xs:string
When parent is ToolButton:
Custom tool name. Used to reference the tool in scripts.
|
![](xsdimages/attributeref.png) |
onclick optional xs:string
Specify the script to run when this event occurs.
|
![](xsdimages/attributeref.png) |
onpointerdown optional xs:string
Specify the script to run when this event occurs.
|
![](xsdimages/attributeref.png) |
onpointermove optional xs:string
Specify the script to run when this event occurs.
|
![](xsdimages/attributeref.png) |
onpointerup optional xs:string
Specify the script to run when this event occurs.
|
![](xsdimages/attribute.png) |
promote optional Restriction of xs:string
Specifies whether the custom menu item will be promoted to the top of the list when selected.
|
![](xsdimages/attributeref.png) |
prompt optional xs:string
The status bar text for the custom tool button.
|
![](xsdimages/attributeref.png) |
shortcut optional xs:string
The function key or action button shortcut for the custom tool button.
|
|
Attributes
Name | Type | Use | Default | Fixed | Description |
caption | xs:string | optional | | | Displayed in the toolbar. |
command | xs:string | optional | | | When parent is ToolButton:
Built-in tool name (for example, addlayer). |
image | xs:string | optional | | | Path to a 16X16 .bmp image file, .ico file or the name of a built-in image (for example, $bex). |
name | xs:string | optional | | | When parent is ToolButton:
Custom tool name. Used to reference the tool in scripts. |
onclick | xs:string | optional | | | Specify the script to run when this event occurs. |
onpointerdown | xs:string | optional | | | Specify the script to run when this event occurs. |
onpointermove | xs:string | optional | | | Specify the script to run when this event occurs. |
onpointerup | xs:string | optional | | | Specify the script to run when this event occurs. |
promote | Restriction of xs:string | optional | false | | Specifies whether the custom menu item will be promoted to the top of the list when selected. |
prompt | xs:string | optional | | | The status bar text for the custom tool button. |
shortcut | xs:string | optional | | | The function key or action button shortcut for the custom tool button. |
Remarks
Examples
Restrictions
- If command is used, caption, image, name, promote, prompt, shortcut, onclick, onpointerdown, onpointermove, and onpointerup cannot also be used.
- If caption, image, name, promote, prompt, shortcut, onclick, onpointerdown, onpointermove, or onpointerup is used, command cannot also be used.
Source
<xs:element maxOccurs="unbounded" name="MENUITEM" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:complexType>
<xs:attribute ref="caption" />
<xs:attribute ref="command" />
<xs:attribute ref="image" />
<xs:attribute ref="name" />
<xs:attribute ref="onclick" />
<xs:attribute ref="onpointerdown" />
<xs:attribute ref="onpointermove" />
<xs:attribute ref="onpointerup" />
<xs:attribute default="false" name="promote">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="true" />
<xs:enumeration value="false" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute ref="prompt" />
<xs:attribute ref="shortcut" />
</xs:complexType>
</xs:element>
|
See Also